gh-113978: Ignore warnings on text completion inside REPL #113979

WolframAlph · 2024-01-12T07:52:49Z

sobolevn

Maybe instead we should do this?

» git patch
diff --git Lib/rlcompleter.py Lib/rlcompleter.py
index 206d6fb511c..62fd2c7fdec 100644
--- Lib/rlcompleter.py
+++ Lib/rlcompleter.py
@@ -176,8 +176,9 @@ def attr_matches(self, text):
                 if (word[:n] == attr and
                     not (noprefix and word[:n+1] == noprefix)):
                     match = "%s.%s" % (expr, word)
+                    import types
                     if isinstance(getattr(type(thisobject), word, None),
-                                  property):
+                                  (property, types.GetSetDescriptorType)):
                         # bpo-44752: thisobject.word is a method decorated by
                         # `@property`. What follows applies a postfix if
                         # thisobject.word is callable, but know we know that

It also solves the issue:

WolframAlph · 2024-01-12T12:40:13Z

Not really sure. My intention was to eliminate all possible warnings during completion (now and in future) no matter where they come from. Maybe it's the only possible path where it can happen but I am not sure since I never dealt with such things. Your solution looks cleaner to me and I believe you have broader context so I leave it up to you to decide.

sobolevn · 2024-01-12T13:28:24Z

My thoughs: properties should not evaluate when auto-complete works, so I think that adding an ignore just hides this problem.

So, we should really address the root of this problem: do not execute .co_lnotab property on code objects (and similar types as well).

WolframAlph · 2024-01-12T14:03:07Z

properties should not evaluate when auto-complete works

I agree. But is this true only for built-in objects and their properties or user defined as well?
Consider following piece of code:

class D:
    def __get__(self, _, __):
        print("evaluated")

class C:
    prop = D()

trying to get suggestions for C. evaluates prop and prints the message.

sobolevn · 2024-01-12T14:45:45Z

We can also try to replace getattr with inspect.getattr_static

WolframAlph · 2024-01-14T18:53:14Z

Some things depend on being evaluated. Using inspect.getattr_static instead of getattr breaks tests.

cpython/Lib/test/test_rlcompleter.py

Lines 51 to 85 in 77b45fa

    
           def test_attr_matches(self): 
        
               # test with builtins namespace 
        
               self.assertEqual(self.stdcompleter.attr_matches('str.s'), 
        
                                ['str.{}('.format(x) for x in dir(str) 
        
                                 if x.startswith('s')]) 
        
               self.assertEqual(self.stdcompleter.attr_matches('tuple.foospamegg'), []) 
        
               expected = sorted({'None.%s%s' % (x, 
        
                                                 '()' if x == '__init_subclass__' 
        
                                                 else '' if x == '__doc__' 
        
                                                 else '(') 
        
                                  for x in dir(None)}) 
        
               self.assertEqual(self.stdcompleter.attr_matches('None.'), expected) 
        
               self.assertEqual(self.stdcompleter.attr_matches('None._'), expected) 
        
               self.assertEqual(self.stdcompleter.attr_matches('None.__'), expected) 
        
               # test with a customized namespace 
        
               self.assertEqual(self.completer.attr_matches('CompleteMe.sp'), 
        
                                ['CompleteMe.spam']) 
        
               self.assertEqual(self.completer.attr_matches('Completeme.egg'), []) 
        
               self.assertEqual(self.completer.attr_matches('CompleteMe.'), 
        
                                ['CompleteMe.mro()', 'CompleteMe.spam']) 
        
               self.assertEqual(self.completer.attr_matches('CompleteMe._'), 
        
                                ['CompleteMe._ham']) 
        
               matches = self.completer.attr_matches('CompleteMe.__') 
        
               for x in matches: 
        
                   self.assertTrue(x.startswith('CompleteMe.__'), x) 
        
               self.assertIn('CompleteMe.__name__', matches) 
        
               self.assertIn('CompleteMe.__new__(', matches) 
        
               with patch.object(CompleteMe, "me", CompleteMe, create=True): 
        
                   self.assertEqual(self.completer.attr_matches('CompleteMe.me.me.sp'), 
        
                                    ['CompleteMe.me.me.spam']) 
        
                   self.assertEqual(self.completer.attr_matches('egg.s'), 
        
                                    ['egg.{}('.format(x) for x in dir(str) 
        
                                     if x.startswith('s')])

Things like __init_subclass__, __class__, mro, etc...

miss-islington-app · 2024-05-22T19:02:15Z

Thanks @WolframAlph for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

…onGH-113979) (cherry picked from commit e03dde5) Co-authored-by: Yan Yanchii <yyanchiy@gmail.com>

bedevere-app · 2024-05-22T19:02:27Z

GH-119429 is a backport of this pull request to the 3.13 branch.

…113979) (#119429) (cherry picked from commit e03dde5) Co-authored-by: Yan Yanchii <yyanchiy@gmail.com>

…on#113979)

pythongh-113978: Ignore warnings on text completion inside REPL

7fe3c23

bedevere-app bot added the awaiting review label Jan 12, 2024

bedevere-app bot mentioned this pull request Jan 12, 2024

Deprecation warning during text completion in REPL #113978

Closed

sobolevn reviewed Jan 12, 2024

View reviewed changes

ambv merged commit e03dde5 into python:main May 21, 2024
30 checks passed

bedevere-app bot removed the awaiting review label May 21, 2024

lysnikolaou added topic-repl Related to the interactive shell needs backport to 3.13 bugs and security fixes labels May 22, 2024

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2024

pythongh-113978: Ignore warnings on text completion inside REPL (pyth…

66f7373

…onGH-113979) (cherry picked from commit e03dde5) Co-authored-by: Yan Yanchii <yyanchiy@gmail.com>

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label May 22, 2024

ambv pushed a commit that referenced this pull request May 22, 2024

[3.13] gh-113978: Ignore warnings on text completion inside REPL (GH-…

6bc7fc0

…113979) (#119429) (cherry picked from commit e03dde5) Co-authored-by: Yan Yanchii <yyanchiy@gmail.com>

JelleZijlstra mentioned this pull request May 28, 2024

backport a9a74da 3.13 #119642

Closed

estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024

pythongh-113978: Ignore warnings on text completion inside REPL (pyth…

2f7af8b

…on#113979)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-113978: Ignore warnings on text completion inside REPL #113979

gh-113978: Ignore warnings on text completion inside REPL #113979

WolframAlph commented Jan 12, 2024

sobolevn left a comment

WolframAlph commented Jan 12, 2024

sobolevn commented Jan 12, 2024

WolframAlph commented Jan 12, 2024 •

edited

Loading

sobolevn commented Jan 12, 2024

WolframAlph commented Jan 14, 2024

miss-islington-app bot commented May 22, 2024

bedevere-app bot commented May 22, 2024

gh-113978: Ignore warnings on text completion inside REPL #113979

gh-113978: Ignore warnings on text completion inside REPL #113979

Conversation

WolframAlph commented Jan 12, 2024

sobolevn left a comment

Choose a reason for hiding this comment

WolframAlph commented Jan 12, 2024

sobolevn commented Jan 12, 2024

WolframAlph commented Jan 12, 2024 • edited Loading

sobolevn commented Jan 12, 2024

WolframAlph commented Jan 14, 2024

miss-islington-app bot commented May 22, 2024

bedevere-app bot commented May 22, 2024

WolframAlph commented Jan 12, 2024 •

edited

Loading